package org.apache.bcel.generic;

import org.apache.bcel.Constants;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache BCEL" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache BCEL", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

import org.apache.bcel.classfile.*;
import java.util.ArrayList;

/**
 * Super class for FieldGen and MethodGen objects, since they have some methods
 * in common!
 * 
 * @version $Id: FieldGenOrMethodGen.java,v 1.3 2006/08/23 13:48:30 andos Exp $
 * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
 */
public abstract class FieldGenOrMethodGen extends AccessFlags implements
		NamedAndTyped, Cloneable {
	protected String name;

	protected String descriptor;

	protected Type type;

	protected ConstantPoolGen cp;

	private ArrayList<Attribute> attribute_vec = new ArrayList<Attribute>();

	protected FieldGenOrMethodGen() {
	}

	public void setType(Type type) {
		if (type.getType() == Constants.T_ADDRESS)
			throw new IllegalArgumentException("Type can not be " + type);

		this.type = type;
	}

	public Type getType() {
		return type;
	}

	/**
	 * @return name of method/field.
	 */
	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public void setDescriptor(String descriptor) {
		this.descriptor = descriptor;
		
	}	
	
	public ConstantPoolGen getConstantPool() {
		return cp;
	}

	public void setConstantPool(ConstantPoolGen cp) {
		this.cp = cp;
	}

	/**
	 * Add an attribute to this method. Currently, the JVM knows about the
	 * `Code', `ConstantValue', `Synthetic' and `Exceptions' attributes. Other
	 * attributes will be ignored by the JVM but do no harm.
	 * 
	 * @param a
	 *            attribute to be added
	 */
	public void addAttribute(Attribute a) {
		attribute_vec.add(a);
	}

	/**
	 * Remove an attribute.
	 */
	public void removeAttribute(Attribute a) {
		attribute_vec.remove(a);
	}

	/**
	 * Remove all attributes.
	 */
	public void removeAttributes() {
		attribute_vec.clear();
	}

	/**
	 * @return all attributes of this method.
	 */
	public Attribute[] getAttributes() {
		Attribute[] attributes = new Attribute[attribute_vec.size()];
		attribute_vec.toArray(attributes);
		return attributes;
	}

	/**
	 * @return signature of method/field.
	 */
	public abstract String getSignature();

	public Object clone() {
		try {
			return super.clone();
		} catch (CloneNotSupportedException e) {
			System.err.println(e);
			return null;
		}
	}
}
